Skip to content

Make README clearer and more concise #5491

Open
fern-api[bot] wants to merge 1 commit into
mainfrom
fern/readme-clarity
Open

Make README clearer and more concise #5491
fern-api[bot] wants to merge 1 commit into
mainfrom
fern/readme-clarity

Conversation

@fern-api

@fern-api fern-api Bot commented May 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Trim and reorganize the repo README so contributors can scan it quickly.

What changed

  • Replaced the wordy intro with a one-line description of what this repo is.
  • Collapsed the two-step ''Installation'' and three-step ''Editing documentation'' flows into a single, tighter ''Run the docs locally'' quickstart.
  • Simplified the prerequisites bullet (single line covers both Node.js and npm).
  • Tightened the writing-tips bullets without dropping any guidance.
  • Condensed the Vale intro and the collapsed style-guideline lists.
  • Reworded the review-process section into two clear bullets.
  • Replaced time-relative phrasing (''currently live'', ''Finally, when you make a PR'') per the in-repo style rules.

No links, code blocks, or substantive guidance were removed — every section in the original README is still present, just shorter.

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner May 13, 2026 16:31
@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 25 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions Bot added the Stale This PR hasn't has any commits or comments in 25 days or more. label Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Stale This PR hasn't has any commits or comments in 25 days or more.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants